home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / comm / tcp / clchat37.lha / CLChat37 / Client / CLChatGUI.doc < prev    next >
Encoding:
Text File  |  1995-03-22  |  16.1 KB  |  455 lines
  1.  
  2.  
  3. CLChatGUI
  4. *********
  5.  
  6. Welcome to the CLChatGUI, a full-featured GUI client to the
  7. CLChatSystem for AmiTCP.  The CLChatSystem, which is
  8. originally part of the Connectline BBS package, provides a
  9. multoi-server, IRC-like chat system with multiple channels, private
  10. messaging, operator privileges and more.
  11.  
  12. Within Connectline, also online user and Hydra file transfer
  13. protocol chat user may join the chat.  See the `CLChatServer
  14. Documentation' for more information about Connectline.
  15.  
  16. Connecting
  17. **********
  18.  
  19. Installation is fairly simply.  Simply put the archive contents
  20. somewhere on your harddisk.  Note that you need MUI 2.3 or better!
  21.  
  22. Before you can use CLChatGUI, you must connect to a chat server
  23. running CLChatD.
  24.  
  25. When started, CLChatGUI will prompt you for a server name and a port
  26. number to connect to.
  27.  
  28. If you are connected to a LAN, you should ask your network adminstrator
  29. for both server name and port number.
  30.  
  31. If you are connected to the Internet, you may try
  32. pluribus.wupper.de at port 5555, but be warned that the Internet
  33. link of this machine is temporary and generally down.  See ARCnet for
  34. a good choice of servers to connect to.
  35.  
  36. You must also specify a Nickname and your Realname.  The nickname
  37. is a kind of username used within the chat system.  It may be up to 15
  38. byte long and must consist of letters, digits and the characters .
  39. and _. The realname is used for informational purposes only.
  40.  
  41. Note that the server may reject your connection attempt because the
  42. entered nickname is invalid or already in use by another chat user.
  43. Change your nick and retry the connection.
  44.  
  45. CLChatGUI keeps a history of the last servers you have connected to.
  46. You may choose from the history by clicking on the popup button right
  47. from the server name string gadget.  The history is saved within the
  48. configuration file.
  49.  
  50. Local chat
  51. **********
  52.  
  53. If you start the client on a machine running the CLChatServer, it
  54. will not connect using AmiTCP, but directly link to the chat server to
  55. reduce overhead.
  56.  
  57. If you want to avoid this behaviour, e.g. for testing purposes, start
  58. CLChatGUI with the TCPMode keyword or specify the
  59. TCPMode tooltype.
  60.  
  61. Using CLChatGUI
  62. ***************
  63.  
  64. After connecting to the chat server, the main window opens.  It
  65. consists of a channel selection gadget, a topic gadget, the main output
  66. window, your input string gadget and the user operation gadget group.
  67. It also features a menu bar with several options and shortcuts for
  68. server commands.
  69.  
  70. You send text to the chat server by simply entering it in the input
  71. gadget.  Commands are also send to the server by entering them in the
  72. input gadget.  You may want to use the /HELP command to learn about
  73. available server commands.  The input gadget is normally automatically
  74. activated; if it is not, simply press SPACE to activate it.  A
  75. history of the last 100 lines entered is kept; you may use
  76. Cursor/UP or Cursor/DOWN for accessing entries in the history.
  77.  
  78. Changing channels is done by entering a new channel name in the channel
  79. selection gadget.  Note that the server will automatically create a
  80. channel if it does not exist. Already existing channels may be selected
  81. with the popup listview right of the channel gadget. The popup button
  82. has a hidden keyboard shortcut h which opens the channel selection
  83. listview.
  84.  
  85. If you have channel operator status, you may change the current
  86. channel's topic by entering a new one in the topic gadget.  The
  87. contents of this gadget are automatically updated if someone else
  88. changes the topic.
  89.  
  90. User operations
  91. ***************
  92.  
  93. The user listview displays all users currently logged into the chat
  94. server and the name of the channel they are currently on. Users with
  95. channel operator privilege are marked with a @, users with chat
  96. operator privilege are marked with a ! before the name.
  97.  
  98. Double clicking on an entry in the user listview requests a /WHOIS
  99. user command from the server.  Pressing the Dialog button opens a
  100. special so-called dialog window.  A dialog window works much like the
  101. main windows, but every text entered within a dialog window is send
  102. directly as a private message to the user.  Also, any incoming private
  103. messages from this user are displayed in the dialog window and not the
  104. main window.  If the Auto checkbox is selected, a new dialog window
  105. is created for the originator of every incoming private message.
  106.  
  107. If you have channel or chat operator privilege, you may also use the
  108. OP, DEOP and KICK buttons to perform the requested operation on
  109. the selected user.
  110.  
  111. Via the PING button you can request a PING request from the selected
  112. user. If the user is running the GUI client, too, you will eventually
  113. receive a reply stating the round-tripe time from you to the remote
  114. user. This is usefull for TCP connections only.
  115.  
  116. If you have a TCP connection, you may also use the Send Files option
  117. to directly send files to the remote user; see FileTransfer for more
  118. information about this operation.
  119.  
  120. Setting the AWAY checkmark causes the AWAY message to be printed, and
  121. every private message to you will automatically respond with Nick is
  122. away (AWAY message).
  123.  
  124. Setup
  125. *****
  126.  
  127. In the setup window, you may modify several operation attributes.
  128.  
  129.     Autoconnect will cause an automatic connection attempt each time
  130. the CLChatGUI is started. Setting Auto Reconnect will cause
  131. automatic reconnect attempts if the connections drops.
  132.  
  133.     File Receive Path specifies the path you want incoming CLFT
  134. files to go (See FileTransfer.). Setting Auto Receive will start a
  135. CLFT receive session without prompting you for confirmation.
  136.  
  137.     Max. Number of Lines specifies how many lines of incoming text
  138. will be stored for the output listview.
  139.  
  140. You may log all or some of the chat server output to a log file; you may
  141. individually select Private, Server or normal Text messages to be
  142. stored in the log file.
  143.  
  144. The Event Handling checkboxes set the reaction of special events.
  145. You may set Deiconify to automatically deiconify the application on
  146. the given event, and DisplayBeep to just have the screen beep.
  147.  
  148. The message section allows you to specify standard texts send to the
  149. chat for given operations. The AWAY message is set when you select
  150. the AWAY checkbox in the main window, the BACK message is send
  151. when you clear the checkbox. The KICK message is a default kick
  152. reason if you kick users using the KICK button below the user
  153. listview.
  154.  
  155. You may create several different configuration files using the
  156. Save... and Load... items from the menu bar.  If you create
  157. icons for the configurations, you can start CLChatGUI by simply
  158. doubly clicking on the configuration icon.
  159.  
  160. FileTransfer
  161. ************
  162.  
  163. If you connect via AmiTCP, you may also use the CLFT protocol to
  164. directly send files to users linked to the chat network (comparable to
  165. the IRC `DCC protocol').  Simply select the user you want to send to,
  166. press the Send files button and a filerequester will open. You can
  167. also directly drop Workbench icons onto the user listview to have the
  168. correspondending files to be send to the currently selected user. If
  169. you have dialog windows open, you may also directly send files by
  170. dropping Workbench icons onto the dialog window.
  171.  
  172. When you have selected files, a CLFT request will be send to the
  173. remote user, and the CLFT sender window will open on your side,
  174. awaiting a connect from the receiving site.  The receiver will then
  175. eventually connect to you via TCP and grab the files offered to him.
  176.  
  177. If you receive incoming CLFT requests, a requester will open showing
  178. you the originator of the request, the number of files to be send and a
  179. list of the files to be transfered.  You may accept or reject the
  180. request, or you may change to destination directory.  Use the
  181. Setup window to change the default path in which incoming files are
  182. stored.  If you have Auto Receive set, no prompt will appear, but
  183. receiving will start immediately.
  184.  
  185. Incoming files are tagged with a filenote designating the originator
  186. nick and IP address for later identification.  If an equally named file
  187. already exists, the file name is postpended with ".2", ".3" etc.
  188.  
  189. You may abort file transfers at any time by clicking on the close
  190. gadget of the receive or send window.  All transfers currently waiting
  191. or in progress will automatically terminate if you quite CLChatGUI.
  192. Note that you cannot send files to users which are connected via TelNet
  193. or the Connectline ANSI client.
  194.  
  195. ARexx commands
  196. **************
  197.  
  198.     CLChatGUI features an ARexx port. The port name is
  199. CLCHATCLIENT.nr, with nr starting at 1 and increasing for
  200. every instance of the program started.
  201.  
  202. Besides the builtin MUI commands (see the `MUI User Guide'),
  203. CLChatGUI current features two commands:
  204.  
  205. SEND TEXT/F
  206.      Sends the given text string as it was entered in the input string
  207.      gadget.  Note that you may also send server commands this way.
  208.  
  209. RECONNECT
  210.      Cause the CLChatGUI to reconnect to the current server.
  211.  
  212. Server Commands
  213. ***************
  214.  
  215. Below is a list of normally available server commands. Don't forget to
  216. use the /HELP command to learn if your server supports a different
  217. command set.
  218.  
  219.    * /CHANNEL [name]
  220.      Join or create a channel
  221.  
  222.    * /INFO [name]
  223.      Show all or specific channel
  224.  
  225.    * /WHO
  226.      List users in channel
  227.  
  228.    * /USERS
  229.      List all users in chat. Note that the output from this command is
  230.      silently interpreted by the client and not displayed in the output
  231.      window.
  232.  
  233.    * /USERS S
  234.      List all users in chat together with the servers they are on
  235.  
  236.    * /WHOIS nick
  237.      Show info about user
  238.  
  239.    * /MSG nick msg
  240.      Send private msg to nick
  241.  
  242.    * /NICK [nick]
  243.      View or change your nick
  244.  
  245.    * /ME msg
  246.      Send action string
  247.  
  248.    * /VERSION
  249.      Show server version
  250.  
  251.    * /SERVERS
  252.      Show other servers connected to your local server
  253.  
  254.     Operator only commands:
  255.  
  256.    * /OP nick
  257.      Give operator state to nick
  258.  
  259.    * /DEOP nick
  260.      Remove operator state from nick
  261.  
  262.    * /TOPIC topic
  263.      Set topic of channel
  264.  
  265.    * /KICK nick reason
  266.      Kick nick out of channel
  267.  
  268. There are also special Chat operator commands which are not visible
  269. to the normal user or channel operator.  Use the /HELP command to
  270. obtain a list of chat operator commands directly from the server.
  271.  
  272. ARCnet
  273. ******
  274.  
  275.     ARCnet, the Amiga Relay Chat Network, is a Internet based
  276. network of CLChatServers available for public usage. As the time of
  277. writing, the following servers were connected to the network:
  278.  
  279.    * ramiga.cts.com
  280.  
  281.    * bouldercreek.com
  282.  
  283.    * will.achilles.net
  284.  
  285.    * online.via.nl
  286.  
  287.    * slip35-116.xs4all.nl
  288.  
  289.    * wizard.hip.cam.org
  290.  
  291.    * nverenin.extern.ucsd.edu
  292.  
  293.    * svcrppp27.epix.net
  294.  
  295. All servers run the CLChatServer on port 5555. Note that some of
  296. these servers are not available for 24h/day.
  297.  
  298. Copyright
  299. *********
  300.  
  301. The CLChatSystem (CLChatServer, CLChatD , CLChatLink and
  302. CLChatGUI) is (C) 1994-1995 Oliver Wagner, All Rights Reserved.
  303.  
  304. The package may be distributed freely as long as all files are
  305. distributed as a whole archive and are not modified in any way.
  306.  
  307.     CLChatGUI is a MUI application.  MUI is (C) 1993-95 Stefan
  308. Stuntz.
  309.  
  310.     AmiTCP is (C) 1994-1995 NSDI Inc.
  311.  
  312. Please send bug-reports, suggestions and comments via E-Mail to
  313. o.wagner@pluribus.wupper.de.
  314.  
  315. Updates are placed on AmiNet; they can also be downloaded via
  316. anonymous FTP directly from pluribus.wupper.de.  You can also check
  317. out anonymous FTP at the servers listed in the ARCnet reference if they
  318. have a better link to your host.
  319.  
  320. History
  321. *******
  322.  
  323. Version 1.7
  324.         * Fixed a bug where small windows caused the the line formatter
  325.           to loop infinitely
  326.  
  327.         * added /SERVERS command to server command menu
  328.  
  329.         * default setting was saved to ENVARC only, so attempting to
  330.           load defaults without quitting caused the old defaults from
  331.           ENV to be read in
  332.  
  333. Version 2.0
  334.         * added CLFT file transfer capability
  335.  
  336.         * added /USERS S command to server command menu
  337.  
  338.         * miscellaneous internal fixes & cleanup work
  339.  
  340.         * now TCPMode can be used as a workbench icon tooltype, too
  341.  
  342. Version 2.1
  343.         * scroller now does not jump to the bottom when new entries are
  344.           appended if it not already was there.
  345.  
  346.         * smoothed out removing of lines in the main listview.
  347.  
  348.         * added PING option to test round trip time to another user.
  349.           Note that his works with the GUI client only!
  350.  
  351.         * fixed workbench startup bug: always attempted to load the
  352.           executable itself as a settings file thus ignoring any
  353.           default settings in ENV:.
  354.  
  355.         * added new option Auto Reconnect to automatically attempt
  356.           to reconnect if the server connections breaks down.
  357.  
  358.         * nick changes are now tracked and correspondending dialog
  359.           windows are updated with the new nickname
  360.  
  361.         * changed ping frequency back to 15s to reduce IP load
  362.  
  363.         * miscellaneous internal fixes & cleanup work
  364.  
  365. Version 2.2 (internal)
  366. Version 2.3
  367.         * smoothed out scroller handling a bit; will now jump to the
  368.           bottom on window resizes, and will jump as long as no more
  369.           than two lines are scrolled up
  370.  
  371.         * file transfer tasks now run with priority 1 for maximum
  372.           performance
  373.  
  374.         * added better icon created by `NEUMANN'
  375.  
  376.         * minor speedup in listview display hook
  377.  
  378.         * added missing cycle chain for option window
  379.  
  380. Version 2.4
  381.         * now activating any output window automatically actives the
  382.           correspondending input string gadget
  383.  
  384. Version 2.5
  385.         * fixed bug with lines > 255 chars to be corrupted upon listview
  386.           insertion
  387.  
  388.         * fixed several types in texts
  389.  
  390.         * now file transfer can be initiated by dropping icons onto a
  391.           dialog window
  392.  
  393.         * will no longer change topic string gadget contents while user
  394.           is editing it
  395.  
  396. Version 2.6 (internal)
  397. Version 2.7 (internal)
  398. Version 2.8
  399.         * changed prefix entries to be more clearly
  400.  
  401.         * fixed several hidden internal race conditions regarding CLFT
  402.           cleanup which could case enf-hits or visits to india
  403.  
  404.         * option window is now a register group
  405.  
  406.         * added CLFT auto receive option
  407.  
  408.         * added logging capability
  409.  
  410.         * added PING and SEND FILE buttons to the user dialog windows
  411.  
  412.         * it is now possible to enter commands in the user dialog
  413.           windows
  414.  
  415.         * added server history feature
  416.  
  417.         * added AWAY feature
  418.  
  419.         * added AWAY, BACK and KICK message configurability
  420.  
  421.         * fixed topic gadget to always update when the window is
  422.           deactivated even if it is the active object
  423.  
  424. Version 2.9
  425.         * changed "««" within dialog window to "IN"
  426.  
  427.         * fixed various problems with dialog window listview handling
  428.           (no proper flushing, no proper jump-to-bottom)
  429.  
  430.         * now dialog windows will automatically be activated when
  431.           "DIALOG" is select for an user for whom a window already
  432.           exists
  433.  
  434.         * removed AmiTCP dependancy due to time() from net.lib. Now has
  435.           it's own, even faster time() implementation using
  436.           timer.device's GetSysTime()
  437.  
  438. Index
  439. *****
  440.  
  441.  
  442.  
  443.  ARCnet                                 ARCnet
  444.  ARexx commands                         ARexx commands
  445.  Connecting                             Connecting
  446.  Copyright                              Copyright
  447.  FileTransfer                           FileTransfer
  448.  History                                History
  449.  Local chat                             Connecting
  450.  Server Commands                        Server Commands
  451.  Setup                                  Setup
  452.  User operations                        Using CLChatGUI
  453.  Using CLChatGUI                        Using CLChatGUI
  454.  
  455.